Update links in doc, fix broken links and move to https when possible#2254
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates various documentation and reference links across Stable-Baselines3 to fix broken URLs and prefer HTTPS where applicable, including some link target replacements.
Changes:
- Updated many HTTP links to HTTPS (papers, docs, project references, and metadata files like CITATION/README).
- Replaced several outdated external links (e.g., project repos, vendor docs) with newer canonical locations.
- Minor doc guidance tweaks (e.g., Windows installer recommendation, pip extras quoting) and link hygiene in Sphinx/doc assets.
Reviewed changes
Copilot reviewed 24 out of 26 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| stable_baselines3/ddpg/ddpg.py | Updated paper link in DDPG docstring to HTTPS. |
| stable_baselines3/common/sb2_compat/rmsprop_tf_like.py | Updated linked lecture PDF to HTTPS. |
| stable_baselines3/common/noise.py | Updated OU noise reference link to HTTPS. |
| README.md | Updated JMLR URL to HTTPS and refreshed some maintainer/organization links. |
| NOTICE | Updated OpenAI URL to HTTPS. |
| docs/modules/ppo.md | Updated gSDE reference link (PR → issue) for inference note. |
| docs/modules/dqn.md | Updated FQI link to a newer PDF location over HTTPS. |
| docs/modules/ddpg.md | Updated DPG paper link to HTTPS. |
| docs/modules/a2c.md | Updated OpenAI blog link and gSDE reference link (PR → issue). |
| docs/misc/projects.md | Updated several external project repository links; removed some dead/outdated links. |
| docs/misc/changelog.md | Added changelog entry for link fixes; updated a few reference URLs. |
| docs/make.bat | Updated Sphinx URL to HTTPS. |
| docs/index.rst | Updated JMLR URL to HTTPS. |
| docs/guide/tensorboard.md | Updated PyTorch TensorBoard doc links and pinned an RL Zoo permalink. |
| docs/guide/sb3_contrib.md | Updated RecurrentPPO implementation-details link. |
| docs/guide/rl.md | Updated Berkeley course link to HTTPS. |
| docs/guide/install.md | Updated Windows installer recommendation, pip command quoting, and proxy example. |
| docs/guide/imitation.md | Updated imitation “first steps” documentation link. |
| docs/guide/export.md | Updated Coral documentation link. |
| docs/guide/examples.md | Updated external project links and permalinks (e.g., Isaac Lab wrapper). |
| docs/guide/checking_nan.md | Updated an imputation article link. |
| docs/conf.py | Updated Sphinx and commented intersphinx URLs to HTTPS. |
| docs/_static/img/colab.svg | Changed SVG namespace URI scheme (needs correction). |
| docs/_static/img/colab-badge.svg | Changed SVG + xlink namespace URI schemes (needs correction). |
| CONTRIBUTING.md | Updated Stack Overflow link to HTTPS. |
| CITATION.bib | Updated JMLR URL to HTTPS. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| :::{note} | ||
| Using gSDE (Generalized State-Dependent Exploration) during inference (see [PR #1767](https://github.com/DLR-RM/stable-baselines3/pull/1767)): | ||
| Using gSDE (Generalized State-Dependent Exploration) during inference (see [issue #1767](https://github.com/DLR-RM/stable-baselines3/issues/1767)): |
|
|
||
| :::{note} | ||
| Using gSDE (Generalized State-Dependent Exploration) during inference (see [PR #1767](https://github.com/DLR-RM/stable-baselines3/pull/1767)): | ||
| Using gSDE (Generalized State-Dependent Exploration) during inference (see [issue #1767](https://github.com/DLR-RM/stable-baselines3/issues/1767)): |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Motivation and Context
Types of changes
Checklist
docs/misc/changelog.md) (required).make format(required)make check-codestyleandmake lint(required)make pytestandmake typeboth pass. (required)make doc(required)Note: You can run most of the checks using
make commit-checks.Note: we are using a maximum length of 127 characters per line